FrameLib  0.7
DSP processing with frames of arbitrary timing and length
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
FrameLib_Object< T > Class Template Referenceabstract

#include <FrameLib_Object.h>

Inheritance diagram for FrameLib_Object< T >:
FrameLib_Queueable< T >

Classes

struct  UntypedConnection
 

Public Types

typedef FrameLib_Queueable< T >::Queue Queue
 

Public Member Functions

 FrameLib_Object (ObjectType type, FrameLib_Context context, void *owner, T *parent)
 
virtual ~FrameLib_Object ()
 
ObjectType getType () const
 
FrameLib_Context getContext () const
 
void * getOwner () const
 
unsigned long getNumIns () const
 
unsigned long getNumOuts () const
 
unsigned long getNumAudioIns () const
 
unsigned long getNumAudioOuts () const
 
unsigned long getNumAudioChans () const
 
virtual void setFixedInput (unsigned long idx, double *input, unsigned long size)=0
 
virtual void blockUpdate (double **ins, double **outs, unsigned long blockSize)=0
 
virtual void reset (double samplingRate, unsigned long maxBlockSize)=0
 
virtual std::string objectInfo (bool verbose=false)
 
virtual std::string inputInfo (unsigned long idx, bool verbose=false)
 
virtual std::string outputInfo (unsigned long idx, bool verbose=false)
 
virtual std::string audioInfo (unsigned long idx, bool verbose=false)
 
virtual FrameType inputType (unsigned long idx) const =0
 
virtual FrameType outputType (unsigned long idx) const =0
 
virtual const FrameLib_Parameters * getParameters () const
 
ConnectionResult addConnection (T *object, unsigned long outIdx, unsigned long inIdx)
 
void deleteConnection (unsigned long inIdx)
 
ConnectionResult addOrderingConnection (T *object, unsigned long outIdx)
 
void deleteOrderingConnection (T *object, unsigned long outIdx)
 
void clearOrderingConnections ()
 
void clearConnections ()
 
bool isConnected (unsigned long inIdx) const
 
virtual void autoOrderingConnections ()=0
 
virtual void clearAutoOrderingConnections ()=0
 
T * getConnection (unsigned long idx) const
 
unsigned long getConnectionIdx (unsigned long idx) const
 
bool supportsOrderingConnections () const
 
unsigned long getNumOrderingConnections () const
 
T * getOrderingConnection (unsigned long idx) const
 
unsigned long getOrderingConnectionIdx (unsigned long idx) const
 
bool isOrderingConnection (T *object) const
 
unsigned long getNumOutputDependencies () const
 
T * getOutputDependency (unsigned long idx) const
 
- Public Member Functions inherited from FrameLib_Queueable< T >
 FrameLib_Queueable ()
 

Static Public Member Functions

static bool handlesAudio ()
 

Protected Member Functions

void setIO (unsigned long nIns, unsigned long nOuts, unsigned long nAudioChans=0)
 
void enableOrderingConnections ()
 
template<class U >
U * alloc (unsigned long N)
 
template<class U >
void dealloc (U *&ptr)
 
void clearAllocator ()
 
FrameLib_LocalAllocator::Storage * registerStorage (const char *name)
 
void releaseStorage (FrameLib_LocalAllocator::Storage *&storage)
 

Static Protected Member Functions

static const char * formatInfo (const char *verboseStr, const char *briefStr, bool verbose)
 
static std::string formatInfo (const char *verboseStr, const char *briefStr, unsigned long idx, bool verbose)
 
static std::string formatInfo (const char *verboseStr, const char *briefStr, const char *replaceStr, bool verbose)
 
static std::string numberedString (const char *str, unsigned long idx)
 

Member Typedef Documentation

◆ Queue

template<class T>
typedef FrameLib_Queueable<T>::Queue FrameLib_Object< T >::Queue

Constructor & Destructor Documentation

◆ FrameLib_Object()

template<class T>
FrameLib_Object< T >::FrameLib_Object ( ObjectType  type,
FrameLib_Context  context,
void *  owner,
T *  parent 
)
inline

◆ ~FrameLib_Object()

template<class T>
virtual FrameLib_Object< T >::~FrameLib_Object ( )
inlinevirtual

Member Function Documentation

◆ addConnection()

template<class T>
ConnectionResult FrameLib_Object< T >::addConnection ( T *  object,
unsigned long  outIdx,
unsigned long  inIdx 
)
inline

◆ addOrderingConnection()

template<class T>
ConnectionResult FrameLib_Object< T >::addOrderingConnection ( T *  object,
unsigned long  outIdx 
)
inline

◆ alloc()

template<class T>
template<class U >
U* FrameLib_Object< T >::alloc ( unsigned long  N)
inlineprotected

◆ audioInfo()

template<class T>
virtual std::string FrameLib_Object< T >::audioInfo ( unsigned long  idx,
bool  verbose = false 
)
inlinevirtual

Reimplemented in FrameLib_Expand< T >.

◆ autoOrderingConnections()

template<class T>
virtual void FrameLib_Object< T >::autoOrderingConnections ( )
pure virtual

Implemented in FrameLib_Expand< T >, FrameLib_Unpack, FrameLib_Pack, and FrameLib_DSP.

◆ blockUpdate()

template<class T>
virtual void FrameLib_Object< T >::blockUpdate ( double **  ins,
double **  outs,
unsigned long  blockSize 
)
pure virtual

Implemented in FrameLib_Expand< T >, FrameLib_DSP, and FrameLib_MultiChannel.

◆ clearAllocator()

template<class T>
void FrameLib_Object< T >::clearAllocator ( )
inlineprotected

◆ clearAutoOrderingConnections()

template<class T>
virtual void FrameLib_Object< T >::clearAutoOrderingConnections ( )
pure virtual

Implemented in FrameLib_Expand< T >, FrameLib_Unpack, and FrameLib_Pack.

◆ clearConnections()

template<class T>
void FrameLib_Object< T >::clearConnections ( )
inline

◆ clearOrderingConnections()

template<class T>
void FrameLib_Object< T >::clearOrderingConnections ( )
inline

◆ dealloc()

template<class T>
template<class U >
void FrameLib_Object< T >::dealloc ( U *&  ptr)
inlineprotected

◆ deleteConnection()

template<class T>
void FrameLib_Object< T >::deleteConnection ( unsigned long  inIdx)
inline

◆ deleteOrderingConnection()

template<class T>
void FrameLib_Object< T >::deleteOrderingConnection ( T *  object,
unsigned long  outIdx 
)
inline

◆ enableOrderingConnections()

template<class T>
void FrameLib_Object< T >::enableOrderingConnections ( )
inlineprotected

◆ formatInfo() [1/3]

template<class T>
static const char* FrameLib_Object< T >::formatInfo ( const char *  verboseStr,
const char *  briefStr,
bool  verbose 
)
inlinestaticprotected

◆ formatInfo() [2/3]

template<class T>
static std::string FrameLib_Object< T >::formatInfo ( const char *  verboseStr,
const char *  briefStr,
unsigned long  idx,
bool  verbose 
)
inlinestaticprotected

◆ formatInfo() [3/3]

template<class T>
static std::string FrameLib_Object< T >::formatInfo ( const char *  verboseStr,
const char *  briefStr,
const char *  replaceStr,
bool  verbose 
)
inlinestaticprotected

◆ getConnection()

template<class T>
T* FrameLib_Object< T >::getConnection ( unsigned long  idx) const
inline

◆ getConnectionIdx()

template<class T>
unsigned long FrameLib_Object< T >::getConnectionIdx ( unsigned long  idx) const
inline

◆ getContext()

template<class T>
FrameLib_Context FrameLib_Object< T >::getContext ( ) const
inline

◆ getNumAudioChans()

template<class T>
unsigned long FrameLib_Object< T >::getNumAudioChans ( ) const
inline

◆ getNumAudioIns()

template<class T>
unsigned long FrameLib_Object< T >::getNumAudioIns ( ) const
inline

◆ getNumAudioOuts()

template<class T>
unsigned long FrameLib_Object< T >::getNumAudioOuts ( ) const
inline

◆ getNumIns()

template<class T>
unsigned long FrameLib_Object< T >::getNumIns ( ) const
inline

◆ getNumOrderingConnections()

template<class T>
unsigned long FrameLib_Object< T >::getNumOrderingConnections ( ) const
inline

◆ getNumOutputDependencies()

template<class T>
unsigned long FrameLib_Object< T >::getNumOutputDependencies ( ) const
inline

◆ getNumOuts()

template<class T>
unsigned long FrameLib_Object< T >::getNumOuts ( ) const
inline

◆ getOrderingConnection()

template<class T>
T* FrameLib_Object< T >::getOrderingConnection ( unsigned long  idx) const
inline

◆ getOrderingConnectionIdx()

template<class T>
unsigned long FrameLib_Object< T >::getOrderingConnectionIdx ( unsigned long  idx) const
inline

◆ getOutputDependency()

template<class T>
T* FrameLib_Object< T >::getOutputDependency ( unsigned long  idx) const
inline

◆ getOwner()

template<class T>
void* FrameLib_Object< T >::getOwner ( ) const
inline

◆ getParameters()

template<class T>
virtual const FrameLib_Parameters* FrameLib_Object< T >::getParameters ( ) const
inlinevirtual

Reimplemented in FrameLib_Expand< T >, FrameLib_Unpack, FrameLib_Pack, and FrameLib_DSP.

◆ getType()

template<class T>
ObjectType FrameLib_Object< T >::getType ( ) const
inline

◆ handlesAudio()

template<class T>
static bool FrameLib_Object< T >::handlesAudio ( )
inlinestatic

◆ inputInfo()

template<class T>
virtual std::string FrameLib_Object< T >::inputInfo ( unsigned long  idx,
bool  verbose = false 
)
inlinevirtual

Reimplemented in FrameLib_Expand< T >, FrameLib_Unpack, and FrameLib_Pack.

◆ inputType()

template<class T>
virtual FrameType FrameLib_Object< T >::inputType ( unsigned long  idx) const
pure virtual

Implemented in FrameLib_Expand< T >, FrameLib_Unpack, FrameLib_Pack, and FrameLib_DSP.

◆ isConnected()

template<class T>
bool FrameLib_Object< T >::isConnected ( unsigned long  inIdx) const
inline

◆ isOrderingConnection()

template<class T>
bool FrameLib_Object< T >::isOrderingConnection ( T *  object) const
inline

◆ numberedString()

template<class T>
static std::string FrameLib_Object< T >::numberedString ( const char *  str,
unsigned long  idx 
)
inlinestaticprotected

◆ objectInfo()

template<class T>
virtual std::string FrameLib_Object< T >::objectInfo ( bool  verbose = false)
inlinevirtual

Reimplemented in FrameLib_Expand< T >, FrameLib_Unpack, and FrameLib_Pack.

◆ outputInfo()

template<class T>
virtual std::string FrameLib_Object< T >::outputInfo ( unsigned long  idx,
bool  verbose = false 
)
inlinevirtual

Reimplemented in FrameLib_Expand< T >, FrameLib_Unpack, and FrameLib_Pack.

◆ outputType()

template<class T>
virtual FrameType FrameLib_Object< T >::outputType ( unsigned long  idx) const
pure virtual

Implemented in FrameLib_Expand< T >, FrameLib_Unpack, FrameLib_Pack, and FrameLib_DSP.

◆ registerStorage()

template<class T>
FrameLib_LocalAllocator::Storage* FrameLib_Object< T >::registerStorage ( const char *  name)
inlineprotected

◆ releaseStorage()

template<class T>
void FrameLib_Object< T >::releaseStorage ( FrameLib_LocalAllocator::Storage *&  storage)
inlineprotected

◆ reset()

template<class T>
virtual void FrameLib_Object< T >::reset ( double  samplingRate,
unsigned long  maxBlockSize 
)
pure virtual

Implemented in FrameLib_Expand< T >, FrameLib_DSP, and FrameLib_MultiChannel.

◆ setFixedInput()

template<class T>
virtual void FrameLib_Object< T >::setFixedInput ( unsigned long  idx,
double *  input,
unsigned long  size 
)
pure virtual

Implemented in FrameLib_Expand< T >, FrameLib_DSP, and FrameLib_MultiChannel.

◆ setIO()

template<class T>
void FrameLib_Object< T >::setIO ( unsigned long  nIns,
unsigned long  nOuts,
unsigned long  nAudioChans = 0 
)
inlineprotected

◆ supportsOrderingConnections()

template<class T>
bool FrameLib_Object< T >::supportsOrderingConnections ( ) const
inline
The documentation for this class was generated from the following file: